monitoring-tools-ux

1.0.x
(0 reviews)

Update Ticket Details from ACUT to Salesforce

/{businessId}/troubleTicket/{id}

[PATCH]

Update comments, contact phone number, queue, status and closing comments in Salesforce from ACUT.

URL
https://[localhost]:[port]/monitoring-tools-ux/v1/{businessId}/troubleTicket/{id}
Param
nametypedescriptionrequired
businessIdstring2 letter ISO 3166 country code (TT, BB, JM, HN, CR, DO etc..) identifying the business unit.
Expected:JM,AI,AG,VG,KY,DM,GD,MS,KN,LC,VC,TC		Y
idstringSalesforce Case IdY
namevaluedescriptionrequired
client_idstringThe client_id identifying the channel.Y
client_secretstringPassword associated with the client_id.Y
X-Correlation-IDstringIdentifier that correlates HTTP request between a client and server.
Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction.
Note - Mule default behavior creates a sample x-correlation-id field if value is not passed from client, API will use this value in case value is not passed in API request syntax: correlationId: uuid:cwc--, example: correlationId: f058ebd6-02f7-4d3f-942e-904344e8cde5:cwc--qa		Y
Salesforce tenants
SF Environment to ConnectSF Instance
QAcwc--qa
UATcwc--uatsfdc
Productioncwc--prod
Body Definitions
nametypedescriptionrequired
channel.idstringDefault: For ACUT-> ACUTY
channel.@typestringDefault: ChannelRefY
note[].idstringDefault: CommentY
note[].textstringComment for the ticketY
note[].@typestringDefault: NoteY
note[].idstringDefault: ClosingCommentY
note[].textstringClosing commentsY
note[].@typestringDefault: NoteY
relatedParty[].idstringSalesforce Contact idY
relatedParty[].@schemaLocationstringDefault: 'https://github.com/tmforum-apis/Open_Api_And_Data_Model/blob/master/schemas/EngagedParty/RelatedPartyWithContactInfo.schema.json'Y
relatedParty[].@typestringDefault: RelatedPartyWithContactInfoY
relatedParty[].rolestringDefault: contactY
relatedParty[].@referredTypestringDefault: IndividualY
relatedParty[].contactMedium[].@referredTypestringDefault: TelephoneMediumY
relatedParty[].contactMedium[].mediumTypestringDefault: TelephoneNumberY
relatedParty[].contactMedium[].characteristic.phoneNumberstringContact phone numberY
relatedEntity[].idstringAssigned user id /queue idY
relatedEntity[].rolestringDefault: AssignedGroupY
relatedEntity[].@referredTypestringDefault: OrganizationY
relatedEntity[].idstringSalesforce appointment idY
relatedEntity[].descriptionstringReason for appointmentY
relatedEntity[].validFor.startDateTimedatetimeStart datetime of appointmentY
relatedEntity[].validFor.endDateTimedatetimeEnd datetime of appointmentY
relatedEntity[].rolestringDefault: requestedAppointmentY
relatedEntity[].@typestringDefault: RelatedEntityY
relatedEntity[].@referredTypestringDefault: AppointmentY
troubleTicketCharacteristic[].namestringname of the characteristic. Default:externalStatusY
troubleTicketCharacteristic[].valuestringvalue of characteristic. Status of the ticketY
Sample Request
{
    "note": [
        {
            "id": "Comment",
            "text": "string",
            "@type": "Note"
        },
        {
            "id": "ClosingComment",
            "text": "string",
            "@type": "Note"
        }
    ],
    "channel": {
        "id": "ACUT",
        "@type": "ChannelRef"
    },
    "relatedEntity": [
        {
            "id": "O",
            "role": "AssignedGroup",
            "@referredType": "Organization"
        },
        {
            "id": "00Tdq000006UkI5EAK",
            "description": "CUSTOMER REQUESTED",
            "validFor": {
                "startDateTime": "2019-12-05T05:30:00.000+05:30",
                "endDateTime": "2019-12-05T06:30:00.000+05:30"
            },
            "role": "requestedAppointment",
            "@type": "RelatedEntity",
            "@referredType": "Appointment"
        }
    ],
    "relatedParty": [
        {
            "id": "003dq000004yL0rAAE",
            "@schemaLocation": "https://github.com/tmforum-apis/Open_Api_And_Data_Model/blob/master/schemas/EngagedParty/RelatedPartyWithContactInfo.schema.json",
            "@type": "RelatedPartyWithContactInfo",
            "role":"contact",
            "@referredType": "Individual",
            "contactMedium": [
                {
                    "@referredType": "TelephoneMedium",
                    "mediumType": "TelephoneNumber",
                    "characteristic": {
                        "phoneNumber": "8879541292"
                    }
                }
            ]
        }
    ],
    "troubleTicketCharacteristic": [
        {
            "name": "externalStatus",
            "value": "assigned"
        }
    ]
}
Sample Response
{
    "note": [
        {
            "id": "Comment",
            "text": "string",
            "@type": "Note"
        },
        {
            "id": "ClosingComment",
            "text": "string",
            "@type": "Note"
        }
    ],
    "channel": {
        "id": "ACUT",
        "@type": "ChannelRef"
    },
    "relatedEntity": [
        {
            "id": "O",
            "role": "AssignedGroup",
            "@referredType": "Organization"
        },
        {
            "id": "00Tdq000006UkI5EAK",
            "description": "CUSTOMER REQUESTED",
            "validFor": {
                "startDateTime": "2019-12-05T05:30:00.000+05:30",
                "endDateTime": "2019-12-05T06:30:00.000+05:30"
            },
            "role": "requestedAppointment",
            "@type": "RelatedEntity",
            "@referredType": "Appointment"
        }
    ],
    "relatedParty": [
        {
            "id": "003dq000004yL0rAAE",
            "@schemaLocation": "https://github.com/tmforum-apis/Open_Api_And_Data_Model/blob/master/schemas/EngagedParty/RelatedPartyWithContactInfo.schema.json",
            "@type": "RelatedPartyWithContactInfo",
            "role":"contact",
            "@referredType": "Individual",
            "contactMedium": [
                {
                    "@referredType": "TelephoneMedium",
                    "mediumType": "TelephoneNumber",
                    "characteristic": {
                        "phoneNumber": "8879541292"
                    }
                }
            ]
        }
    ],
    "troubleTicketCharacteristic": [
        {
            "name": "externalStatus",
            "value": "assigned"
        }
    ]
}

Reviews